<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>sfplay3m</title>
    <link rel="stylesheet" type="text/css" href="csound.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <link rel="home" href="index.html" title="The Canonical Csound Reference Manual" />
    <link rel="up" href="OpcodesTop.html" title="Orchestra Opcodes and Operators" />
    <link rel="prev" href="sfplay3.html" title="sfplay3" />
    <link rel="next" href="sfplay.html" title="sfplay" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">sfplay3m</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="sfplay3.html">Prev</a> </td>
          <th width="60%" align="center">Orchestra Opcodes and Operators</th>
          <td width="20%" align="right"> <a accesskey="n" href="sfplay.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="refentry">
      <a id="sfplay3m"></a>
      <div class="titlepage"></div>
      <a id="IndexSfplay3m" class="indexterm"></a>
      <div class="refnamediv">
        <h2>
          <span class="refentrytitle">sfplay3m</span>
        </h2>
        <p>sfplay3m — 
      Plays a SoundFont2 (SF2) sample preset, generating a mono sound with cubic interpolation.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp146682736"></a>
        <h2>Description</h2>
        <p>
      Plays a SoundFont2 (SF2) sample preset, generating a mono sound with cubic interpolation. These opcodes allow management the sample-structure of SF2 files. In order to understand the usage of these opcodes, the user must have some knowledge of the SF2 format, so a brief description of this format can be found in the <a class="link" href="MiscSf2.html" title="Appendix G. SoundFont2 File Format"><em class="citetitle">SoundFont2 File Format Appendix</em></a>.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp146685136"></a>
        <h2>Syntax</h2>
        <pre class="synopsis">ares <span class="command"><strong>sfplay3m</strong></span> ivel, inotenum, xamp, xfreq, ipreindex [, iflag] [, ioffset] [, ienv]</pre>
      </div>
      <div class="refsect1">
        <a id="idp146687312"></a>
        <h2>Initialization</h2>
        <p>
      <span class="emphasis"><em>ivel</em></span> -- velocity value
    </p>
        <p>
      <span class="emphasis"><em>inotenum</em></span> -- MIDI note number value
    </p>
        <p>
      <span class="emphasis"><em>ipreindex</em></span> -- preset index
    </p>
        <p>
      <span class="emphasis"><em>iflag</em></span> (optional) -- flag regarding the behavior of <span class="emphasis"><em>xfreq</em></span> and <span class="emphasis"><em>inotenum</em></span>
    </p>
        <p>
      <span class="emphasis"><em>ioffset</em></span> (optional) -- start playing at offset, in samples.
    </p>
        <p>
      <span class="emphasis"><em>ienv</em></span> (optional) -- enables and determines amplitude envelope. 0 = no envelope, 1 = linear attack and decay, 2 = linear attack, exponential decay (see below). Default = 0.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp146694224"></a>
        <h2>Performance</h2>
        <p>
      <span class="emphasis"><em>xamp</em></span> -- amplitude correction factor
    </p>
        <p>
      <span class="emphasis"><em>xfreq</em></span> -- frequency value or frequency multiplier, depending by <span class="emphasis"><em>iflag</em></span>. When <span class="emphasis"><em>iflag</em></span> = 0, <span class="emphasis"><em>xfreq</em></span> is a multiplier of a the default frequency, assigned by SF2 preset to the <span class="emphasis"><em>inotenum</em></span> value. When <span class="emphasis"><em>iflag</em></span> = 1, <span class="emphasis"><em>xfreq</em></span> is the absolute frequency of the output sound, in Hz. Default is 0.
    </p>
        <p>
      When <span class="emphasis"><em>iflag</em></span> = 0, <span class="emphasis"><em>inotenum</em></span> sets the frequency of the output according to the MIDI note number used, and <span class="emphasis"><em>xfreq</em></span> is used as a multiplier. When <span class="emphasis"><em>iflag</em></span> = 1, the frequency of the output, is set directly by <span class="emphasis"><em>xfreq</em></span>. This allows the user to use any kind of micro-tuning based scales. However, this method is designed to work correctly only with presets tuned to the default equal temperament. Attempts to use this method with a preset already having non-standard tunings, or with drum-kit-based presets, could give unexpected results.
    </p>
        <p>
      Adjustment of the amplitude can be done by varying the <span class="emphasis"><em>xamp</em></span> argument, which acts as a multiplier.
    </p>
        <p>
      Notice that both <span class="emphasis"><em>xamp</em></span> and <span class="emphasis"><em>xfreq</em></span> can use k-rate as well as a-rate signals. Both arguments must use variables of the same rate, or <span class="emphasis"><em>sfplay3m</em></span> will not work correctly. <span class="emphasis"><em>ipreindex</em></span> must contain the number of a previously assigned preset, or Csound will crash.
    </p>
        <p>
      The <span class="emphasis"><em>ioffset</em></span> parameter allows the sound to start from a sample different than the first one. The user should make sure that its value is within the length of the specific sound. Otherwise, Csound will probably crash.
    </p>
        <p>
      The <span class="emphasis"><em>ienv</em></span> parameter enables and determines the type of amplitude envelope used. The default value is 0, or no envelope. If <span class="emphasis"><em>ienv</em></span> is set to 1, the attack and decay portions are linear. If set to 2, the attack is linear and the decay is exponential. The release portion of the envelope has not yet been implemented.
    </p>
        <p>
      <span class="emphasis"><em>sfplay3m</em></span> is a mono version of <a class="link" href="sfplay3.html" title="sfplay3"><em class="citetitle">sfplay3</em></a>. It should be used with mono preset, or with the stereo presets in which stereo output is not required. It is faster than <span class="emphasis"><em>sfplay3</em></span>. 
    </p>
        <p>
      <span class="emphasis"><em>sfplay3m</em></span> is also a cubic-interpolation version of <a class="link" href="sfplaym.html" title="sfplaym"><em class="citetitle">sfplaym</em></a>. Difference of sound-quality is noticeable specially in bass-frequency-transposed samples. In high-freq-transposed samples the difference is less noticeable, and I suggest to use linear-interpolation versions, because they are faster.
    </p>
        <p>
      These opcodes only support the sample structure of SF2 files. The modulator structure of the SoundFont2 format is not supported in Csound. Any modulation or processing to the sample data is left to the Csound user, bypassing all restrictions forced by the SF2 standard.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp146713696"></a>
        <h2>Examples</h2>
        <p>
      Here is an example of the sfplay3m opcode. It uses the file <a class="ulink" href="examples/sfplay3m.csd" target="_top"><em class="citetitle">sfplay3m.csd</em></a>.
      </p>
        <div class="example">
          <a id="idp146715552"></a>
          <p class="title">
            <strong>Example 811. Example of the sfplay3m opcode.</strong>
          </p>
          <div class="example-contents">
            <p>See the sections <a class="link" href="UsingRealTime.html" title="Real-Time Audio"><em class="citetitle">Real-time Audio</em></a> and <a class="link" href="CommandFlags.html" title="Csound command line"><em class="citetitle">Command Line Flags</em></a> for more information on using command line flags.</p>
            <pre class="programlisting">
<span class="csdtag">&lt;CsoundSynthesizer&gt;</span>
<span class="csdtag">&lt;CsOptions&gt;</span>
<span class="comment">; Select audio/midi flags here according to platform</span>
-odac -+rtmidi=virtual -M0 <span class="comment">;;;realtime audio out</span>
<span class="comment">;-iadc    ;;;uncomment -iadc if realtime audio input is needed too</span>
<span class="comment">; For Non-realtime ouput leave only the line below:</span>
<span class="comment">; -o sfplay3m.wav -W ;;; for file output any platform</span>
<span class="csdtag">&lt;/CsOptions&gt;</span>
<span class="csdtag">&lt;CsInstruments&gt;</span>

<span class="ohdr">sr</span> <span class="op">=</span> 44100 
<span class="ohdr">ksmps</span> <span class="op">=</span> 32
<span class="ohdr">nchnls</span> <span class="op">=</span> 2
<span class="ohdr">0dbfs</span>  <span class="op">=</span> 1 


gisf	<span class="opc">sfload</span>	"07AcousticGuitar.sf2"
	<span class="opc">sfplist</span>	gisf
	<span class="opc">sfpassign</span> 10, gisf

<span class="oblock">instr</span> 1	<span class="comment">; play from score and midi keyboard</span>

	<span class="opc">mididefault</span>	60, p3
	<span class="opc">midinoteonkey</span>	p4, p5
inum	<span class="opc">init</span>	p4
ivel	<span class="opc">init</span>	p5
ivel	<span class="opc">init</span>	ivel<span class="op">/</span>127					<span class="comment">;make velocity dependent</span>
kamp	<span class="opc">linsegr</span>	1, 1, 1, .1, 0
kamp	<span class="op">=</span> kamp<span class="op">/</span>7000						<span class="comment">;scale amplitude</span>
kfreq	<span class="opc">init</span>	1						<span class="comment">;do not change freq from sf</span>
aout	<span class="opc">sfplay3m</span> ivel, inum, kamp<span class="op">*</span>ivel, kfreq, 10		<span class="comment">;preset index = 10</span>
	<span class="opc">outs</span>	aout, aout
	
<span class="oblock">endin</span>
	
<span class="csdtag">&lt;/CsInstruments&gt;</span>
<span class="csdtag">&lt;CsScore&gt;</span>
<span class="stamnt">f</span>0  60	<span class="comment">; stay active for 1 minute</span>

<span class="stamnt">i</span>1 0 1 60 127
<span class="stamnt">i</span>1 + 1 62 &lt;
<span class="stamnt">i</span>1 + 1 65 &lt;
<span class="stamnt">i</span>1 + 1 69 10

<span class="stamnt">e</span>
<span class="csdtag">&lt;/CsScore&gt;</span>
<span class="csdtag">&lt;/CsoundSynthesizer&gt;</span>
</pre>
          </div>
        </div>
        <p><br class="example-break" />
    </p>
      </div>
      <div class="refsect1">
        <a id="idp146719840"></a>
        <h2>See Also</h2>
        <p>
      <a class="link" href="sfilist.html" title="sfilist"><em class="citetitle">sfilist</em></a>,
      <a class="link" href="sfinstr3.html" title="sfinstr3"><em class="citetitle">sfinstr3</em></a>,
      <a class="link" href="sfinstr3m.html" title="sfinstr3m"><em class="citetitle">sfinstr3m</em></a>,
      <a class="link" href="sfinstr.html" title="sfinstr"><em class="citetitle">sfinstr</em></a>,
      <a class="link" href="sfinstrm.html" title="sfinstrm"><em class="citetitle">sfinstrm</em></a>,
      <a class="link" href="sfload.html" title="sfload"><em class="citetitle">sfload</em></a>,
      <a class="link" href="sfpassign.html" title="sfpassign"><em class="citetitle">sfpassign</em></a>,
      <a class="link" href="sfplay3.html" title="sfplay3"><em class="citetitle">sfplay3</em></a>,
      <a class="link" href="sfplaym.html" title="sfplaym"><em class="citetitle">sfplaym</em></a>,
      <a class="link" href="sfplay.html" title="sfplay"><em class="citetitle">sfplay</em></a>,
      <a class="link" href="sfplist.html" title="sfplist"><em class="citetitle">sfplist</em></a>,
      <a class="link" href="sfpreset.html" title="sfpreset"><em class="citetitle">sfpreset</em></a>
    </p>
      </div>
      <div class="refsect1">
        <a id="idp146732448"></a>
        <h2>Credits</h2>
        <p>
      </p>
        <table border="0" summary="Simple list" class="simplelist">
          <tr>
            <td>Author: Gabriel Maldonado</td>
          </tr>
          <tr>
            <td>Italy</td>
          </tr>
          <tr>
            <td>May 2000</td>
          </tr>
        </table>
        <p>
    </p>
        <p>New in Csound Version 4.07</p>
        <p>New optional parameter <span class="emphasis"><em>ienv</em></span> in version 5.09</p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="sfplay3.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="OpcodesTop.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="sfplay.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">sfplay3 </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> sfplay</td>
        </tr>
      </table>
    </div>
  </body>
</html>
